vcRealListProperty

Typed property that holds a list of values.

See in: Overview

Module: vcCore

Parent: vcProperty

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
TypevcListPropertyTypeRGets the property type.
Valuelist[Real]RWGets or sets the property value.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
waitForobjectList[Real] OR None value,
Optional Keyword[waitTrigger = Boolean]
Blocks script execution until vcProperty.Value is equal to the "value".
See more
This function returns an awaitable task. It must be awaited.

Parameters:
value (object): Value that is used for comparison. When the value is equal to vcProperty.Value, the task completes.
Optional: waitTrigger (boolean): False by default. When waitTrigger is True, the task will wait for the value to change first, before comparing it against "value". Otherwise, the comparison is done immediately and when the values match, the task will complete without blocking the script.

Returns:
Awaitable[List]: The task instance. When awaited, returns a list of event arguments that the event has been triggered with.
waitForNotobjectList[Real] OR None value,
Optional Keyword[waitTrigger = Boolean]
Blocks script execution until vcProperty.Value is not equal to the "value".
See more
This function returns an awaitable task. It must be awaited.

Parameters:
value (object): Value that is used for comparison. When the value is not equal to vcProperty.Value, the task completes.
Optional: waitTrigger (boolean): False by default. When waitTrigger is True, the task will wait for the value to change first, before comparing it against "value". Otherwise, the comparison is done immediately and when the values do not match, the task will complete without blocking the script.

Returns:
Awaitable[List]: The task instance. When awaited, returns a list of event arguments that the event has been triggered with.